/*
This file is part of the iText (R) project.
Copyright (c) 1998-2025 Apryse Group NV
Authors: Apryse Software.

This program is offered under a commercial and under the AGPL license.
For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.

AGPL licensing:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.
*/
using iText.Kernel.Pdf.Tagging;

namespace iText.Kernel.Pdf.Tagutils {
    /// <summary>
    /// Handler for
    /// <see cref="TagTreeIterator"/>.
    /// </summary>
    /// <remarks>
    /// Handler for
    /// <see cref="TagTreeIterator"/>.
    /// Is used to handle specific events during the traversal.
    /// </remarks>
    public interface ITagTreeIteratorHandler {
        /// <summary>Checks whether the element should be traversed.</summary>
        /// <param name="node">the element to check</param>
        /// <returns>
        /// 
        /// <see langword="true"/>
        /// if the iteration should be continued,
        /// <see langword="false"/>
        /// otherwise
        /// </returns>
        bool Accept(IStructureNode node);

        /// <summary>Called when the next element is reached during the traversal to process it.</summary>
        /// <param name="elem">the element to process</param>
        void ProcessElement(IStructureNode elem);
    }
}
